home *** CD-ROM | disk | FTP | other *** search
/ Perl Multimedia Cyber Classroom / PERL Multimedia Cyber Classroom (Prentice Hall)(1998).ISO / jre / readme < prev   
Text File  |  1997-11-24  |  20KB  |  449 lines
  1.  
  2.                              README
  3.  
  4.                   The Java(tm) Runtime Environment
  5.                            JRE 1.1.5  
  6.  
  7. -----------------------------------------------------------------------
  8. CONTENTS
  9.  
  10.   Overview of Java Runtime
  11.     - Introduction
  12.     - The Java Runtime Interpreter
  13.     - Required vs. Optional Files
  14.     - Win 32 Files 
  15.        - Required Files
  16.        - Optional Files
  17.     - Solaris Files 
  18.        - Required Files
  19.        - Optional Files
  20.  
  21.   Bundling and Running the Java Runtime
  22.     - Bundling the Java Runtime
  23.     - Java Runtime Example
  24.     - Runtime Documentation
  25.  
  26.  
  27. =======================================================================
  28.                         OVERVIEW OF JAVA RUNTIME
  29. =======================================================================
  30.  
  31. -----------------------------------------------------------------------
  32. INTRODUCTION
  33. -----------------------------------------------------------------------
  34.  
  35. This is version 1.1.5 of the Java Runtime Environment, also known as 
  36. the Java Runtime, or JRE.  The Java Runtime is the minimum standard
  37. Java Platform for running Java programs.  It contains the Java 
  38. Virtual Machine, Java Core Classes and supporting files. 
  39.  
  40. The JRE can be invoked from the command line by using the jre tool 
  41. (see the following section). On Windows platforms, the jre tool will 
  42. ignore the CLASSPATH environment variable. For both Windows and 
  43. Solaris platforms, the -cp option is recommended to specify an 
  44. application's class path.
  45.  
  46. This document uses the term "vendors" to refer to licensees, 
  47. developers, and independent software vendors (ISVs) who 
  48. license and distribute the JRE with their Java programs.
  49.  
  50. The Win32 version of JRE 1.1.5 has an installer suitable for use 
  51. by end-users. This gives software developers the option of not 
  52. bundling the JRE with their applications. Instead, they can direct 
  53. end-users to download and install the JRE themselves.
  54.  
  55. An installer is not available for Solaris versions of the JRE. 
  56. Developers should bundle the JRE and an installer with their Solaris 
  57. applications. 
  58.  
  59. The JRE includes all of the non-debuggable .dll or .so files plus
  60. the necessary classes from the JDK 1.1.5 to support a runtime-only 
  61. program.  The JRE does not include any of the development tools
  62. (such as appletviewer or javac) or classes that would pertain only 
  63. to a development system.
  64.  
  65. Vendors must follow the terms of the JRE Binary Code License agreement, 
  66. which includes these terms:
  67.  
  68.  - Don't arbitrarily subset the JRE. You may omit only the
  69.    files listed below as optional. 
  70.  
  71.  - Include in your product's license the provisions called out
  72.    in the JRE Binary Code License.
  73.  
  74. Comments regarding the JRE are welcome. Please send them to 
  75. jre-comments@java.sun.com. Due to the large volume of email received 
  76. each day, JavaSoft usually cannot respond to your email personally.
  77.     
  78. The JRE is a product of Sun Microsystems, Inc.  
  79. JavaSoft is an operating company of Sun, and develops the JRE.
  80.  
  81.  
  82. -----------------------------------------------------------------------
  83. THE JAVA RUNTIME INTREPRETER
  84. -----------------------------------------------------------------------
  85.  
  86. The jre tool invokes the Java Runtime interpreter for executing Java 
  87. applications. The tool is available in the Win32, Solaris-Sparc, and 
  88. Solaris x86 downloads of the JRE. The syntax for the jre command is:
  89.  
  90.     jre [ options ] classname <args>
  91.  
  92. The classname argument is the name of the class file to be 
  93. executed. Any arguments to be passed to the class must be placed 
  94. after the classname on the command line.
  95.  
  96. An alternative version of the tool, jrew, is available for Win32. The 
  97. jrew command is identical to jre, except that a console window is not 
  98. invoked. The syntax of the jrew command is 
  99.  
  100.     jrew [ options ] classname <args>
  101.  
  102. On Windows platforms, the jre tool will ignore the CLASSPATH 
  103. environment variable. For both Windows and Solaris platforms, the 
  104. -cp option is recommended to specify an application's class path.
  105.  
  106. Options for the jre and the jrew commands are as follows:
  107.  
  108.    -classpath path    Specifies the path that jre uses to 
  109.                look up classes. Overrides the default 
  110.                classpath.  
  111.  
  112.    -cp path        Prepends the specified path to the default 
  113.                classpath that jre uses to look up classes. 
  114.  
  115.    -help        Print a usage message.
  116.  
  117.    -mx x        Sets the maximum size of the memory allocation 
  118.                pool (the garbage collected heap) to x. The 
  119.                default is 16 megabytes of memory. x must be
  120.             greater than or equal to 1000 bytes.
  121.  
  122.    -ms x        Sets the startup size of the memory allocation 
  123.                pool (the garbage collected heap) to x. The 
  124.                default is 1 megabyte of memory. x must be
  125.             greater than 1000 bytes.
  126.  
  127.    -noasyncgc        Turns off asynchronous garbage collection. When 
  128.                activated, no garbage collection takes place 
  129.                unless it is explicitly called or the program 
  130.             runs out of memory.
  131.  
  132.    -noclassgc        Turns off garbage collection of Java classes. 
  133.                By default, the Java interpreter reclaims space 
  134.                for unused Java classes during garbage collection.
  135.  
  136.    -nojit        Specifies that any JIT compiler should be 
  137.             ignored. The default Java interpreter is invoked.
  138.  
  139.    -ss x        The -ss option sets the maximum stack size that 
  140.                can be used by C code in a thread to x. The 
  141.             default units for x are bytes. The value of x 
  142.             must be greater than or equal to 1000 bytes.
  143.  
  144.    -oss x        The -oss option sets the maximum stack size 
  145.             that can be used by Java code in a thread to x. 
  146.             The default units for x are bytes. The value of 
  147.             x must be greater than or equal to 1000 bytes.
  148.  
  149.    -v, -verbose        Causes jre to print a message to stdout each 
  150.             time a class file is loaded.
  151.  
  152.    -verify        Performs byte-code verification on the class 
  153.             file. Beware, however, that java -verify does 
  154.             not perform a full verification in all 
  155.             situations. Any code path that is not actually 
  156.             executed by the interpreter is not verified. 
  157.             Therefore, java -verify cannot be relied upon to 
  158.             certify class files unless all code paths in 
  159.             the class file are actually run.
  160.  
  161.    -verifyremote    Runs the verifier on all code that is loaded 
  162.             into the system via a classloader. verifyremote 
  163.             is the default for the interpreter.
  164.  
  165.    -noverify        Turns verification off.
  166.  
  167.    -verbosegc        Causes the garbage collector to print out 
  168.             messages whenever it frees memory.
  169.    
  170.    -DpropName=value    Defines a property value. propName is the name 
  171.             of the property whose value you want to change 
  172.             and value is the value to change it to. For 
  173.             example, the command 
  174.             java -Dawt.button.color=green ...
  175.             sets the value of the property awt.button.color 
  176.             to "green".
  177.  
  178.  
  179. -----------------------------------------------------------------------
  180. REQUIRED vs. OPTIONAL FILES
  181. -----------------------------------------------------------------------
  182.  
  183. Licensees must follow the terms of the accompanying LICENSE.  
  184. The files that make up the JRE are divided into two categories:
  185. required and optional.  To paraphrase that license, files that 
  186. are marked "optional" here do not need to be included with the 
  187. licensee's program.
  188.  
  189. The term "required" means licensees who distribute the runtime 
  190. must include those files with their program, whether or not their 
  191. program ever uses those files.  Those files are a required part of 
  192. the Java Platform.
  193.  
  194. Most of the optional files provide localization support for languages.
  195.  
  196. The JRE includes the bin and lib directories which both must
  197. reside in the same directory.  We call this directory <runtime-dir>.
  198.  
  199. In the following lists, all paths are relative to the <runtime-dir>
  200. directory (which is originally "jre1.1.5").
  201.  
  202. -----------------------------------------------------------------------
  203. WIN32 FILES
  204. -----------------------------------------------------------------------
  205.  
  206. Two versions of JRE 1.1.5 for Win32 are available. One version contains 
  207. files for internationalization support. The version with 
  208. internationalization support contains all the files listed below under 
  209. both the REQUIRED FILES and OPTIONAL FILES subsections. A smaller 
  210. version of the Win32 JRE is available that does not contain those 
  211. optional files that provide internationalization support.
  212.  
  213. REQUIRED FILES --------------------------------------------------------
  214.  
  215. The Win32 bin directory contains the executables and native libraries:
  216.  
  217.    bin\jre.exe                   Java runtime executable
  218.    bin\jrew.exe                  Java runtime executable, no console window
  219.    bin\javai.dll                 Java runtime native code library
  220.    bin\jdbcodbc.dll              native code support for sun.jdbc
  221.    bin\jpeg.dll                  native code support for sun.jpeg
  222.    bin\math.dll                  native code support for java.math
  223.    bin\mmedia.dll                native code support for sun.audio
  224.    bin\net.dll                   native code support for java.net
  225.    bin\sysresource.dll           native code support for sun.net.www.protocol
  226.    bin\winawt.dll                native code support for sun.awt
  227.    bin\zip.dll                   native code support for java.util.zip
  228.  
  229. The Win32 lib directory contains the classes and property files:
  230.  
  231.    lib\rt.jar                    Java runtime core classes
  232.    lib\content-types.properties  MIME-type properties 
  233.    lib\awt.properties            properties for key events for java.awt
  234.    lib\font.properties           Win32 font properties for java.awt
  235.    lib\serialver.properties      serialization properties
  236.    lib\security\java.security    properties for java.security
  237.  
  238. OPTIONAL FILES --------------------------------------------------------
  239.  
  240. The following files are optional:
  241.  
  242.    lib\i18n.jar                  I18N character conversion classes from sun.io
  243.    lib\font.properties.ja        AWT font properties for Japanese locale
  244.    lib\font.properties.ko        AWT font properties for Korean locale
  245.    lib\font.properties.zh_TW     AWT font properties for Traditional Chinese locale
  246.    lib\font.properties.zh        AWT font properties for Simplified Chinese locale
  247.    bin\msvcrt.dll                native code C runtime library
  248.  
  249.  
  250. -----------------------------------------------------------------------
  251. SOLARIS FILES
  252. -----------------------------------------------------------------------
  253.   
  254. You can optionally install the Solaris Native Threads Pack 1.1.5 in the 
  255. Solaris versions of the JRE. (The Native Threads Pack is available for 
  256. download from the JDK download site.)  With the native threads pack 
  257. installed, you can use either the native threads files or the default 
  258. set of threads files (called "green threads") when running programs 
  259. with the JRE. If you redistribute the JRE, you must include either the 
  260. entire set of default green threads files, or the entire set of native 
  261. threads files, or both entire sets.
  262.  
  263.  
  264. REQUIRED FILES --------------------------------------------------------
  265.  
  266. The directory <sys> varies depending on the hardware architecture 
  267. (either "sparc" or "i386") and threads implementation (either 
  268. "green_threads" or "native_threads"). To indicate the green threads 
  269. implementation on Solaris-SPARC, for example, <sys> would stand for 
  270. "sparc/green_threads".  If the Solaris native threads pack is installed 
  271. in the Solaris-x86 JRE, for another example, <sys> could stand for 
  272. "i386/native_threads". When redistributing the JRE, you must include 
  273. either the entire set of default green threads files, or the entire set 
  274. of native threads files, or both entire sets.
  275.  
  276.    The Solaris bin directory contains the shell scripts and executables:
  277.  
  278.    bin/jre                      Java runtime shell script
  279.    bin/<sys>/jre                Java runtime executable
  280.  
  281.    The Solaris lib directory and its subdirectories contain the 
  282.    classes, properties files and native libraries:
  283.  
  284.    lib/rt.jar                    Java runtime core classes
  285.    lib/content-types.properties  MIME-type properties 
  286.    lib/awt.properties            properties for key events for java.awt
  287.    lib/font.properties           Solaris font properties for java.awt
  288.    lib/serialver.properties      serialization properties
  289.    lib/security/java.security    properties for java.security
  290.  
  291.    lib/<sys>/libjava.so          Java runtime library
  292.    lib/<sys>/libnet.so           native code support for java.net
  293.    lib/<sys>/libmath.so          native code support for java.math
  294.    lib/<sys>/libmmedia.so        native code support for sun.audio
  295.    lib/<sys>/libawt.so           native code support for sun.awt
  296.    lib/<sys>/libjpeg.so          native code support for sun.jpeg
  297.    lib/<sys>/libJdbcOdbc.so      native code support for sun.jdbc
  298.    lib/<sys>/libsysresource.so   native code support for sun.net
  299.    lib/<sys>/libzip.so           native code support for java.util.zip
  300.  
  301. OPTIONAL FILES --------------------------------------------------------
  302.  
  303. The following files are optional.
  304.  
  305.    lib/i18n.jar                  I18N character conversion classes from sun.io
  306.    lib/font.properties.cs        AWT font properties for Czech locale
  307.    lib/font.properties.pl        AWT font properties for Polish locale
  308.    lib/font.properties.hu        AWT font properties for Hungarian locale
  309.    lib/font.properties.lt        AWT font properties for Lithuanian locale
  310.    lib/font.properties.lv        AWT font properties for Latvian locale
  311.    lib/font.properties.el        AWT font properties for Greek locale
  312.    lib/font.properties.tr        AWT font properties for Turkish locale
  313.    lib/font.properties.ja        AWT font properties for Japanese locale
  314.    lib/psfont.properties.ja      AWT psfont properties for Japanese locale
  315.    lib/font.properties.ru        AWT font properties for Russian locale
  316.    lib/font.properties.ko        AWT font properties for Korean locale
  317.    lib/font.properties.zh_GB2312 AWT font properties for Simplified Chinese locale
  318.    lib/font.properties.zh_TW_Big5  AWT font properties for Traditional Chinese locale
  319.    lib/font.properties.zh_TW_CNS11643 Alternative AWT font properties for Traditional Chinese locale
  320.    lib/<sys>/libXm.so            Symbolic link to Motif runtime library 
  321.    lib/<sys>/libXm.so.3          Motif runtime library
  322.  
  323. libXm.so.3 is present in Solaris 2.5 and later, so is needed only if 
  324. your program is to run on Solaris 2.4 or earlier.
  325.  
  326.  
  327. =======================================================================
  328.                 BUNDLING AND RUNNING THE JAVA RUNTIME
  329. =======================================================================
  330.  
  331. -----------------------------------------------------------------------
  332. BUNDLING THE JAVA RUNTIME
  333. -----------------------------------------------------------------------
  334.  
  335. This release of the JRE for Win32 comes with its own installer that 
  336. makes is suitable for downloading by end users. Java application 
  337. developers have the option of not bundling the JRE with their software. 
  338. Instead, they can direct end-users to download and install the JRE 
  339. themselves.
  340.  
  341. Solaris versions of the JRE do not have an installer. Software 
  342. developers should bundle the JRE and installer with their Solaris 
  343. software. 
  344.  
  345. When bundling the JRE with application software on Solaris, the 
  346. following points should be considered:
  347.  
  348. 1) It is suggested that the JRE be installed in its own subdirectory
  349.    (referred to below as <runtime-dir>).  Include all the the required
  350.    files listed above in the bin and lib subdirectories of 
  351.    <runtime-dir>, following the same directory hierarchy and 
  352.    relative placement of files.  The internationalization files 
  353.    marked optional can be included for language localization support.
  354.  
  355. 2) It is suggested that all application-specific classes be placed 
  356.    in a directory other than <runtime-dir>. Application-specific 
  357.    classes may be individual .class files, .jar files, or .zip 
  358.    files.
  359.  
  360.    An example directory structure might look like the following:
  361.  
  362.                <app-dir>
  363.        ________________|___________
  364.       |         |               |
  365.          bin       lib           <runtime-dir>
  366.           |         |          ________|________
  367.                  app.jar      |                 | 
  368.                              bin               lib         
  369.                               |                 |
  370.                        
  371.  
  372. 3) If native code support is required, then the native library must be 
  373.    located in LD_LIBRARY_PATH on Solaris or the executable search PATH 
  374.    on Win32. The best way to do this is to install the native libraries
  375.    in either <app-dir>/lib/<sys> on Solaris or <app-dir>\bin 
  376.    on Win32. LD_LIBRARY_PATH (on Solaris) or PATH (on Win32) should 
  377.    then be set to include these directories.
  378.  
  379. 4) The application can be invoked by using the jre command-line tool, 
  380.    using the -cp option to specify the application's class path. In 
  381.    the example directory tree above, for example, the command might 
  382.    look like this:
  383.  
  384.    <app-dir>/<runtime-dir>/bin/jre -cp <app-dir>/lib/app.jar <classname>
  385.  
  386.    Information on the jre command-line tool can be found in the 
  387.    JRE 1.1.5 CHANGES file and on the JavaSoft web site at 
  388.    http://java.sun.com/products/jdk1.1/docs/tooldocs/solaris/jre.html
  389.    and
  390.    http://java.sun.com/products/jdk1.1/docs/tooldocs/win32/jre.html
  391.  
  392.    Source code for the jre tool can be found in the Windows JDK 1.1.5 
  393.    directory tree in the jdk1.1.5\demo\jre\win32 folder. For the 
  394.    Solaris JDK 1.1.5, jre source code files can be found in the 
  395.    jdk1.1.5/demo/jre/solaris directory.
  396.  
  397.   
  398. For more information that might be relevant to installing and running
  399. the JRE, refer to the JDK installation instructions:
  400.  
  401.     http://java.sun.com/products/jdk/1.1/installation-win32-x86.html
  402.     http://java.sun.com/products/jdk/1.1/installation-solaris2.html
  403.  
  404.  
  405. -----------------------------------------------------------------------
  406. JAVA RUNTIME EXAMPLE
  407. -----------------------------------------------------------------------
  408.  
  409. The following web page has a Hello World example that you can download 
  410. demonstrating how to create a simple Java application that runs on, 
  411. and is bundled with, the Java Runtime Environment.  
  412.  
  413.      http://java.sun.com/products/jdk/1.1/jre/example/
  414.  
  415. This example shows how to make a simple, seamless transition
  416. from developing an application with the JDK, to deploying it with 
  417. the more-lightweight JRE.
  418.  
  419.  
  420. -----------------------------------------------------------------------
  421. RUNTIME DOCUMENTATION
  422. -----------------------------------------------------------------------
  423.  
  424. Runtime documentation is any documentation that an end-user might
  425. need after they have installed a Java program that runs on the JRE.
  426.  
  427. We supply the following runtime documentation:
  428.  
  429.   - Each property file contains comments that describe what the
  430.     file is useful for and how to modify it.
  431.  
  432.   - awt.properties file - KeyEvent uses it to print out properties of
  433.     key events, usually for debugging purposes.  This might be used
  434.     by a GUI debugger that needs to print out events.
  435.  
  436.   - fontprop.html file has a web page describing how to add 
  437.     fonts to the runtime.  This document is part of the 
  438.     JDK documentation, and is located both in the JDK documentation
  439.     download bundle and at the JavaSoft website:
  440.  
  441.     http://java.sun.com/products/jdk/1.1/docs/guide/intl/fontprop.html
  442.  
  443.  
  444. -----------------------------------------------------------------------
  445. Copyright ⌐ 1997 Sun Microsystems, Inc.
  446. 901 San Antonio Rd., Palo Alto, CA 94303 USA.
  447. All rights reserved.
  448.  
  449.